//----------------------------------*-C++-*----------------------------------//
/*!
 * \file   SimpleXS.hh
 * \author Jeremy Roberts
 * \date   Jul 17, 2011
 * \brief  A simple container for input-based cross-section data.
 * \note   Copyright (C) 2011 Jeremy Roberts. 
 */
//---------------------------------------------------------------------------//
// $Rev::                                               $:Rev of last commit
// $Author:: j.alyn.roberts@gmail.com                   $:Author of last commit
// $Date::                                              $:Date of last commit
//---------------------------------------------------------------------------//

#ifndef SIMPLEXS_HH_
#define SIMPLEXS_HH_

#include <vector>

#include "material/Materials.hh"
#include "material/Cross_Section.hh"
#include "../utilities/DBC.hh"
#include "../utilities/SP.hh"

namespace slabtran
{

/*!
 *  \class SimpleXS
 *  \brief A simple container for input-based cross-section data.
 *
 *  This class is designed for use with cross-section data entered
 *  directly via user input (as opposed to an external library) and
 *  for a few built in testing sets.
 *
 *  The structure is extremely simple, containing the number of groups,
 *  number of materials, and a 2d array of the actual data of the form
 *  \verbatim
 *  [ { sigma(m1,g1), sigma_a(m1,g1), sigma_f(m1,g1), nu(m1,g1), chi(m1,g1), sigma_s(m1,g1->g1), ..., sigma_s(m1,g1->gG) },
 *    { sigma(m1,g2), ... },
 *    { sigma(m2,g1), ... },
 *    ... ,
 *    { sigma(mM,gG), ..., sigma_s(M,gG->gG) } ].
 *  \endverbatim
 *
 *  A method is included that builds \ref Cross_Section objects from the
 *  data and places then  in \ref Materials object.
 *
 *  \todo Extract the reusable body from BuiltInCrossSections and put it
 *        here as SimpleXS is probably a suitable format for small test
 *        data.
 *
 */
class SimpleXS
{

};

}

#endif /* SIMPLEXS_HH_ */

//---------------------------------------------------------------------------//
//              end of SimpleXS.hh
//---------------------------------------------------------------------------//
